/** \addtogroup List 链表操作
 * \{ */


#ifndef _LINUX_LIST_H
#define _LINUX_LIST_H

#include "stddef.h"

#if defined(__HC12__) || defined(__XGATE__)
#pragma push
#pragma MESSAGE DISABLE C3604 /*Static 'list_del' was not referenced*/
#endif

#define LIST_POISON1 ((void *)0xFFFFFE)
#define LIST_POISON2 ((void *)0xFFFFFF)

struct list_head {
    struct list_head *prev;
    struct list_head *next;
};

#define container_of(ptr, type, member) ((type *)((char *)((char *)(ptr) - offsetof(type, member))))

/*
 * Simple doubly linked list implementation.
 *
 * Some of the internal functions ("__xxx") are useful when
 * manipulating whole lists rather than single entries, as
 * sometimes we already know the next/prev entries and we can
 * generate better code by using them directly rather than
 * using the generic single-entry routines.
 */

#define LIST_HEAD_INIT(name) { &(name), &(name) }

#define LIST_HEAD(name) \
	(struct list_head name = LIST_HEAD_INIT(name))

extern inline void INIT_LIST_HEAD(struct list_head *list);

/**
 * list_add - add a new entry
 * \param new new entry to be added
 * \param head list head to add it after
 *
 * Insert a new entry after the specified head.
 * This is good for implementing stacks.
 */
extern inline void list_add(struct list_head *new, struct list_head *head);


/**
 * list_add_tail - add a new entry
 * \param new new entry to be added
 * \param head list head to add it before
 *
 * Insert a new entry before the specified head.
 * This is useful for implementing queues.
 */
extern inline void list_add_tail(struct list_head *new, struct list_head *head);

/**
 * list_del - deletes entry from list.
 * \param entry the element to delete from the list.
 * Note: list_empty() on entry does not return true after this, the entry is
 * in an undefined state.
 */
extern inline void list_del(struct list_head *entry);

/**
 * list_replace - replace old entry by new one
 * \param old  the element to be replaced
 * \param new  the new element to insert
 *
 * If @old was empty, it will be overwritten.
 */
extern inline void list_replace(const struct list_head *old,
                                struct list_head *new);

extern inline void list_replace_init(struct list_head *old,
                                     struct list_head *new);

/**
 * list_del_init - deletes entry from list and reinitialize it.
 * \param entry the element to delete from the list.
 */
extern inline void list_del_init(struct list_head *entry);

/**
 * list_move - delete from one list and add as another's head
 * \param list the entry to move
 * \param head the head that will precede our entry
 */
extern inline void list_move(struct list_head *list, struct list_head *head);

/**
 * list_move_tail - delete from one list and add as another's tail
 * \param list the entry to move
 * \param head the head that will follow our entry
 */
extern inline void list_move_tail(struct list_head *list,
                                  struct list_head *head);

/**
 * list_is_last - tests whether @list is the last entry in list @head
 * \param list the entry to test
 * \param head the head of the list
 */
extern inline int list_is_last(const struct list_head *list,
                               const struct list_head *head);

/**
 * list_empty - tests whether a list is empty
 * \param head the list to test.
 */
extern inline int list_empty(const struct list_head *head);

/**
 * list_empty_careful - tests whether a list is empty and not being modified
 * \param head the list to test
 *
 * Description:
 * tests whether a list is empty _and_ checks that no other CPU might be
 * in the process of modifying either member (next or prev)
 *
 * NOTE: using list_empty_careful() without synchronization
 * can only be safe if the only activity that can happen
 * to the list entry is list_del_init(). Eg. it cannot be used
 * if another CPU could re-list_add() it.
 */
extern inline int list_empty_careful(const struct list_head *head);

/**
 * list_rotate_left - rotate the list to the left
 * \param head the head of the list
 */
extern inline void list_rotate_left(struct list_head *head);

/**
 * list_is_singular - tests whether a list has just one entry.
 * \param head the list to test.
 */
extern inline int list_is_singular(const struct list_head *head);

/**
 * list_cut_position - cut a list into two
 * \param list a new list to add all removed entries
 * \param head a list with entries
 * \param entry an entry within head, could be the head itself
 *	and if so we won't cut the list
 *
 * This helper moves the initial part of @head, up to and
 * including @entry, from @head to @list. You should
 * pass on @entry an element you know is on @head. @list
 * should be an empty list or a list you do not care about
 * losing its data.
 *
 */
extern inline void list_cut_position(struct list_head *list,
                                     struct list_head *head, struct list_head *entry);

/**
 * list_splice - join two lists, this is designed for stacks
 * \param list the new list to add.
 * \param head the place to add it in the first list.
 */
extern inline void list_splice(const struct list_head *list,
                               struct list_head *head);

/**
 * list_splice_tail - join two lists, each list being a queue
 * \param list the new list to add.
 * \param head the place to add it in the first list.
 */
extern inline void list_splice_tail(const struct list_head *list,
                                    struct list_head *head);

/**
 * list_splice_init - join two lists and reinitialise the emptied list.
 * \param list the new list to add.
 * \param head the place to add it in the first list.
 *
 * The list at @list is reinitialised
 */
extern inline void list_splice_init(struct list_head *list,
                                    struct list_head *head);

/**
 * list_splice_tail_init - join two lists and reinitialise the emptied list
 * \param list the new list to add.
 * \param head the place to add it in the first list.
 *
 * Each of the lists is a queue.
 * The list at @list is reinitialised
 */
extern inline void list_splice_tail_init(struct list_head *list,
                                         struct list_head *head);

/**
 * list_entry - get the struct for this entry
 * \param ptr	the &struct list_head pointer.
 * \param type	the type of the struct this is embedded in.
 * \param member	the name of the list_head within the struct.
 */
#define list_entry(ptr, type, member) \
	container_of(ptr, type, member)

/**
 * list_first_entry - get the first element from a list
 * \param ptr	the list head to take the element from.
 * \param type	the type of the struct this is embedded in.
 * \param member	the name of the list_head within the struct.
 *
 * Note, that list is expected to be not empty.
 */
#define list_first_entry(ptr, type, member) \
	list_entry((ptr)->next, type, member)

/**
 * list_last_entry - get the last element from a list
 * \param ptr	the list head to take the element from.
 * \param type	the type of the struct this is embedded in.
 * \param member	the name of the list_head within the struct.
 *
 * Note, that list is expected to be not empty.
 */
#define list_last_entry(ptr, type, member) \
	list_entry((ptr)->prev, type, member)

/**
 * list_first_entry_or_null - get the first element from a list
 * \param ptr	the list head to take the element from.
 * \param type	the type of the struct this is embedded in.
 * \param member	the name of the list_head within the struct.
 *
 * Note that if the list is empty, it returns NULL.
 */
#define list_first_entry_or_null(ptr, type, member) \
	(!list_empty(ptr) ? list_first_entry(ptr, type, member) : NULL)

/**
 * list_next_entry - get the next element in list
 * \param pos	the type * to cursor
 * \param member	the name of the list_head within the struct.
 */
#define list_next_entry(pos, member) \
	list_entry((pos)->member.next, typeof(*(pos)), member)

/**
 * list_prev_entry - get the prev element in list
 * \param pos	the type * to cursor
 * \param member	the name of the list_head within the struct.
 */
#define list_prev_entry(pos, member) \
	list_entry((pos)->member.prev, typeof(*(pos)), member)

/**
 * list_for_each	-	iterate over a list
 * \param pos	the &struct list_head to use as a loop cursor.
 * \param head	the head for your list.
 */
#define list_for_each(pos, head) \
	for (pos = (head)->next; pos != (head); pos = pos->next)

/**
 * list_for_each_prev	-	iterate over a list backwards
 * \param pos	the &struct list_head to use as a loop cursor.
 * \param head	the head for your list.
 */
#define list_for_each_prev(pos, head) \
	for (pos = (head)->prev; pos != (head); pos = pos->prev)

/**
 * list_for_each_safe - iterate over a list safe against removal of list entry
 * \param pos	the &struct list_head to use as a loop cursor.
 * \param n		another &struct list_head to use as temporary storage
 * \param head	the head for your list.
 */
#define list_for_each_safe(pos, n, head) \
	for (/*lint --e(960) */pos = (head)->next, n = pos->next; pos != (head); \
		/*lint --e(960) */pos = n, n = pos->next)

/**
 * list_for_each_prev_safe - iterate over a list backwards safe against removal of list entry
 * \param pos	the &struct list_head to use as a loop cursor.
 * \param n		another &struct list_head to use as temporary storage
 * \param head	the head for your list.
 */
#define list_for_each_prev_safe(pos, n, head) \
	for (/*lint --e(960) */pos = (head)->prev, n = pos->prev; \
	     pos != (head); \
	     /*lint --e(960) */pos = n, n = pos->prev)

/**
 * list_for_each_entry	-	iterate over list of given type
 * \param pos	the type * to use as a loop cursor.
 * \param head	the head for your list.
 * \param member	the name of the list_head within the struct.
 */
#define list_for_each_entry(pos, head, member)				\
	for (pos = list_first_entry(head, typeof(*pos), member);	\
	     &pos->member != (head);					\
	     pos = list_next_entry(pos, member))

/**
 * list_for_each_entry_reverse - iterate backwards over list of given type.
 * \param pos	the type * to use as a loop cursor.
 * \param head	the head for your list.
 * \param member	the name of the list_head within the struct.
 */
#define list_for_each_entry_reverse(pos, head, member)			\
	for (pos = list_last_entry(head, typeof(*pos), member);		\
	     &pos->member != (head); 					\
	     pos = list_prev_entry(pos, member))

/**
 * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
 * \param pos	the type * to use as a start point
 * \param head	the head of the list
 * \param member	the name of the list_head within the struct.
 *
 * Prepares a pos entry for use as a start point in list_for_each_entry_continue().
 */
#define list_prepare_entry(pos, head, member) \
	((pos) ? : list_entry(head, typeof(*pos), member))

/**
 * list_for_each_entry_continue - continue iteration over list of given type
 * \param pos	the type * to use as a loop cursor.
 * \param head	the head for your list.
 * \param member	the name of the list_head within the struct.
 *
 * Continue to iterate over list of given type, continuing after
 * the current position.
 */
#define list_for_each_entry_continue(pos, head, member) 		\
	for (pos = list_next_entry(pos, member);			\
	     &pos->member != (head);					\
	     pos = list_next_entry(pos, member))

/**
 * list_for_each_entry_continue_reverse - iterate backwards from the given point
 * \param pos	the type * to use as a loop cursor.
 * \param head	the head for your list.
 * \param member	the name of the list_head within the struct.
 *
 * Start to iterate over list of given type backwards, continuing after
 * the current position.
 */
#define list_for_each_entry_continue_reverse(pos, head, member)		\
	for (pos = list_prev_entry(pos, member);			\
	     &pos->member != (head);					\
	     pos = list_prev_entry(pos, member))

/**
 * list_for_each_entry_from - iterate over list of given type from the current point
 * \param pos	the type * to use as a loop cursor.
 * \param head	the head for your list.
 * \param member	the name of the list_head within the struct.
 *
 * Iterate over list of given type, continuing from current position.
 */
#define list_for_each_entry_from(pos, head, member) 			\
	for (; &pos->member != (head);					\
	     pos = list_next_entry(pos, member))

/**
 * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
 * \param pos	the type * to use as a loop cursor.
 * \param n		another type * to use as temporary storage
 * \param head	the head for your list.
 * \param member	the name of the list_head within the struct.
 */
#define list_for_each_entry_safe(pos, n, head, member)			\
	for (/*lint --e(960) */pos = list_first_entry(head, typeof(*pos), member), n = list_next_entry(pos, member);	\
	     &pos->member != (head); 					\
	     /*lint --e(960) */pos = n, n = list_next_entry(n, member))

#define list_for_each_entry_safe_with_type(pos, n, type, head, member)			\
	for (/*lint --e(960) */pos = list_first_entry(head, type, member), n = list_next_entry(pos, member);	\
	     &pos->member != (head); 					\
	     /*lint --e(960) */pos = n, n = list_next_entry(n, member))

/**
 * list_for_each_entry_safe_continue - continue list iteration safe against removal
 * \param pos	the type * to use as a loop cursor.
 * \param n		another type * to use as temporary storage
 * \param head	the head for your list.
 * \param member	the name of the list_head within the struct.
 *
 * Iterate over list of given type, continuing after current point,
 * safe against removal of list entry.
 */
#define list_for_each_entry_safe_continue(pos, n, head, member) 		\
	for (/*lint --e(960) */pos = list_next_entry(pos, member), n = list_next_entry(pos, member);	\
	     &pos->member != (head);						\
	     /*lint --e(960) */pos = n, n = list_next_entry(n, member))

/**
 * list_for_each_entry_safe_from - iterate over list from current point safe against removal
 * \param pos	the type * to use as a loop cursor.
 * \param n		another type * to use as temporary storage
 * \param head	the head for your list.
 * \param member	the name of the list_head within the struct.
 *
 * Iterate over list of given type from current point, safe against
 * removal of list entry.
 */
#define list_for_each_entry_safe_from(pos, n, head, member) 			\
	for (n = list_next_entry(pos, member);					\
	     &pos->member != (head);						\
	     /*lint --e(960) */pos = n, n = list_next_entry(n, member))

/**
 * list_for_each_entry_safe_reverse - iterate backwards over list safe against removal
 * \param pos	the type * to use as a loop cursor.
 * \param n		another type * to use as temporary storage
 * \param head	the head for your list.
 * \param member	the name of the list_head within the struct.
 *
 * Iterate backwards over list of given type, safe against removal
 * of list entry.
 */
#define list_for_each_entry_safe_reverse(pos, n, head, member)		\
	for (/*lint --e(960) */pos = list_last_entry(head, typeof(*pos), member),	n = list_prev_entry(pos, member);	\
	     &pos->member != (head); 					\
	     /*lint --e(960) */pos = n, n = list_prev_entry(n, member))

/**
 * list_safe_reset_next - reset a stale list_for_each_entry_safe loop
 * \param pos	the loop cursor used in the list_for_each_entry_safe loop
 * \param n		temporary storage used in list_for_each_entry_safe
 * \param member	the name of the list_head within the struct.
 *
 * list_safe_reset_next is not safe to use in general if the list may be
 * modified concurrently (eg. the lock is dropped in the loop body). An
 * exception to this is if the cursor element (pos) is pinned in the list,
 * and list_safe_reset_next is called after re-taking the lock and before
 * completing the current iteration of the loop body.
 */
#define list_safe_reset_next(pos, n, member)				\
	(n = list_next_entry(pos, member))


#if defined(__HC12__) || defined(__XGATE__)
#pragma pop
#endif


#endif

/** \} */
